Patterns for Documenting Frameworks - Part II
نویسندگان
چکیده
Good design and implementation are necessary but not sufficient pre-requisites for the successful reuse of object-oriented frameworks. Although not always recognized, good documentation is crucial for effective framework reuse and comes with many issues. Defining and writing good quality documentation for a framework is often hard, costly, and tiresome, especially when not aware of its key problems and the best ways to address them. This document presents patterns from a set of related patterns that describe proven solutions to recurrent problems of documenting object-oriented frameworks. The pattern language they all form together aims at helping non-experts on cost-effectively documenting object-oriented frameworks. The patterns here presented address the problems of explaining how to use a framework and illustrating what it can be good for, respectively the patterns “COOKBOOK & RECIPES” and “GRADED EXAMPLES”.
منابع مشابه
Patterns for Documenting Frameworks – Part I
Good design and implementation are necessary but not sufficient pre-requisites for the successful reuse of object-oriented frameworks. Although not always recognized, good documentation is crucial for effective framework reuse, and comes with many issues. Defining and writing good quality documentation for a framework is often hard, costly, and tiresome, especially when not aware of its key pro...
متن کاملPatterns for Documenting Frameworks – Part III
Good design and implementation are necessary but not sufficient pre-requisites for the successful reuse of object-oriented frameworks. Although not always recognized, good documentation is crucial for effective framework reuse and comes with many issues. Defining and writing good quality documentation for a framework is often hard, costly, and tiresome, especially when not aware of its key prob...
متن کاملUML-based Approach for Documenting and Specializing Frameworks Using Patterns and Concern Architectures
Documenting an application framework is a non-trivial task. The most challenging part is the specialization interface that is used to derive specialized versions of the framework. Application developers using the framework should be able to grasp easily the associated classes and their collaborations. Patterns have provided partial support but in the case of highly complicated software platform...
متن کاملConquering Fine-Grained Blends of Design Patterns
The reuse of design patterns in realistic software systems is often a result of blending multiple pattern elements together rather than instantiating them in an isolated manner. Pattern blends can manifest in heterogeneous ways, typically including overlaps and interlaces of inner class members taking part in the patterns implementation. The explicit description of pattern compositions is the k...
متن کاملA Reuse Case Perspective on Documenting Frameworks
A framework is developed in order to support the development of a family of applications. Many approaches to documenting frameworks have been tried, though with different aims and audiences in mind. Of greatest utility are those aimed at reducing the learning curve for application
متن کامل